Skip to content

YARD documentation improvements#179

Merged
teoljungberg merged 2 commits intomasterfrom
yard-documentation-improvements
Oct 31, 2025
Merged

YARD documentation improvements#179
teoljungberg merged 2 commits intomasterfrom
yard-documentation-improvements

Conversation

@teoljungberg
Copy link
Owner

  • Add proper YARD type annotations to all public API methods
  • Change Fixnum → Integer (Fixnum is deprecated in modern Ruby)
  • s/prescedence/precedence
  • Add [void] return type annotations where appropriate
  • Fix documentation for update_trigger (was "trigger to drop", should be
    "trigger to update")
  • Improve consistency of documentation format across adapters,
    configuration, and statements

- Add proper YARD type annotations to all public API methods
- Change Fixnum → Integer (Fixnum is deprecated in modern Ruby)
- Fix typo: "prescedence" → "precedence"
- Add [void] return type annotations where appropriate
- Fix documentation for update_trigger (was "trigger to drop", should be "trigger to update")
- Improve consistency of documentation format across adapters, configuration, and statements

These changes improve code documentation without changing any behavior.
@teoljungberg teoljungberg changed the title Add YARD documentation improvements YARD documentation improvements Oct 31, 2025
@teoljungberg teoljungberg merged commit 6bf8e2c into master Oct 31, 2025
9 checks passed
@teoljungberg teoljungberg deleted the yard-documentation-improvements branch October 31, 2025 09:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant